Simplify Workflow Interface #330
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/unittest-all |
Summary of ChangesHello @pan-x-c, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly simplifies the interface for defining workflow behaviors by migrating key properties from instance-level methods to class-level attributes. This change enhances clarity and consistency in workflow declarations, particularly for features like resettability, repeatability, and asynchronous execution. Concurrently, the underlying system for managing auxiliary models has been improved to correctly provision synchronous or asynchronous OpenAI clients based on the workflow's declared asynchronous nature, ensuring proper integration and functionality. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request does a great job of simplifying the workflow interface by replacing instance properties with class properties (can_reset, can_repeat, is_async) and moving rollout_args into SimpleWorkflow. The changes are applied consistently across a large number of files, including documentation and tests.
However, the refactoring of rollout_args has introduced a critical issue in several workflow classes that inherit from Workflow but not SimpleWorkflow. These classes still attempt to access self.rollout_args, which no longer exists in the base Workflow class, and will cause runtime errors. I've left specific comments on the affected files with suggestions on how to fix this.
Once these issues are addressed, this will be a solid improvement to the codebase.
trinity/common/workflows/envs/agentscope/agentscopev1_search_workflow.py
Show resolved
Hide resolved
Summary
Skipped
Tests
Github Test Reporter by CTRF 💚 |
hiyuchang
reviewed
Oct 21, 2025
hiyuchang
reviewed
Oct 21, 2025
|
Minor comment, Others LGTM |
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the Workflow interface to replace instance properties with class properties for workflow configuration, and ensures asynchronous workflows receive async-compatible auxiliary model clients.
Key Changes:
- Replaced instance properties (
resettable,repeatable,asynchronous) with class properties (can_reset,can_repeat,is_async) - Asynchronous workflows now receive
openai.AsyncOpenAIclients instead ofopenai.OpenAIclients for auxiliary models - Moved
rollout_argsproperty from baseWorkflowclass toSimpleWorkflowclass
Reviewed Changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| trinity/explorer/workflow_runner.py | Added async client list and conditional logic to pass appropriate client type based on workflow's is_async property |
| trinity/common/workflows/workflow.py | Replaced instance properties with class properties; deprecated old properties; moved rollout_args to SimpleWorkflow |
| trinity/common/workflows/step_wise_workflow.py | Removed overridden property methods in favor of class properties |
| trinity/common/workflows/simple_mm_workflow.py | Replaced asynchronous property with is_async class property |
| trinity/common/workflows/math_ruler_workflow.py | Replaced asynchronous property with is_async class property |
| trinity/common/workflows/math_rm_workflow.py | Replaced asynchronous property with is_async class property |
| trinity/common/workflows/eval_workflow.py | Removed overridden property methods; added is_async class property |
| trinity/common/workflows/envs/webshop/webshop_workflow.py | Replaced property methods with class properties |
| trinity/common/workflows/envs/sciworld/sciworld_workflow.py | Replaced asynchronous property with is_async class property |
| trinity/common/workflows/envs/email_searcher/workflow.py | Replaced property methods with class properties; updated rollout_args access pattern |
| trinity/common/workflows/envs/alfworld/alfworld_workflow.py | Replaced asynchronous property with is_async class property |
| trinity/common/workflows/envs/alfworld/RAFT_reflect_alfworld_workflow.py | Removed asynchronous property method |
| trinity/common/workflows/envs/alfworld/RAFT_alfworld_workflow.py | Replaced property methods with class properties |
| trinity/common/workflows/envs/agentscope/agentscopev1_search_workflow.py | Replaced property methods with class properties; updated rollout_args access pattern |
| trinity/common/workflows/envs/agentscope/agentscopev1_react_workflow.py | Replaced property methods with class properties; updated rollout_args access pattern |
| trinity/common/workflows/envs/agentscope/agentscopev0_react_workflow.py | Replaced property method with class property; updated rollout_args access pattern |
| trinity/common/workflows/customized_toolcall_workflows.py | Replaced asynchronous property with is_async class property |
| trinity/common/workflows/customized_math_workflows.py | Replaced asynchronous property with is_async class property |
| trinity/common/workflows/agentscope_workflow.py | Removed property methods; added is_async class property |
| trinity/common/workflows/agentscope/react/react_workflow.py | Replaced property methods with class property; updated rollout_args access pattern |
| tests/explorer/workflow_test.py | Updated test workflows to use class properties; added validation for auxiliary_models client types |
| tests/explorer/scheduler_test.py | Updated test workflows to use class properties |
| docs/sphinx_doc/source_zh/tutorial/develop_workflow.md | Updated documentation to reflect class property usage |
| docs/sphinx_doc/source/tutorial/develop_workflow.md | Updated documentation to reflect class property usage |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
hiyuchang
approved these changes
Oct 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
can_reset,can_repeat,is_asyncto replace instance propertyresettable,repeatable,asynchronousopenai.AsyncOpenAIauxiliary modelsrollout_argsintoSimpleWorkflowChecklist
Please check the following items before code is ready to be reviewed.